home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / vwansi20.zip / VWANSI.DOC < prev    next >
Text File  |  1991-12-14  |  12KB  |  293 lines
  1.                          Online ANSI Viewer v. 2.0
  2.                            (c) 1991 E.L. Morrow
  3.                        written in  Turbo Pascal  5.5
  4.                            utilizing RMDOOR 1.0
  5.  
  6.                                    -by-
  7.  
  8.                                 E.L. Morrow
  9.                  Work of Art BBS (SysOp)     (707)465-3193
  10.                  Voice Phone                 (707)465-6765 9:00am-9:00pm
  11.                                              BBS Node 2    9:00pm-9:00am 
  12.                                              (For Validated Members only!)
  13.  
  14.  
  15.   DISCLAIMER:   
  16.         I relinquish any and all responsibility for anything that may
  17.   occur due to the use of this program, correctly or incorrectly.  I am
  18.   in no way libel for any damage that is attributed to the use of this
  19.   program by any and all persons.
  20.  
  21.  
  22.   SHAREWARE:
  23.         Online ANSI Viewer v2.0 is ShareWare.  It's not crippled or
  24.   anything, but it does let your users know that it isn't registered by
  25.   showing #UNREGISTERED# at the top of the header on the selection menus.
  26.   
  27.         Registration is only $15 for this new version.  Future upgrades
  28.   will be priced accordingly depending on how much is changed and added.
  29.   Anyone who registers now will never have to pay for another registration
  30.   of this program.  Your registration number will be good for all versions.
  31.  
  32.         Distribution of this program will be solely the province of the
  33.   large number of BBS's across the country.  I can't afford to send disks
  34.   out to people who register.  I know this sounds kind of crude, but if
  35.   you enclose your BBS number when you register along with a password to
  36.   get on your system, I'll upload the latest version (if it's different) 
  37.   and send you a private message in an appropriate conference that will
  38.   list your registration information (just a reg number and name actually).
  39.  
  40.         Print and fill out the form in this archive called TTANSI.REG
  41.   and mail it to:
  42.                         Elm L. Morrow
  43.                         911 N. Pacific Ave Apt 15
  44.                         Crescent City, CA 95531
  45.  
  46.         Make checks or money orders payable to: Elm L. Morrow
  47.  
  48.   SETTING UP:
  49.  
  50.         This new version of the ANSI Viewer is multi-node.  In order to
  51.   use this door on a multi-node BBS you need to have a configuration file
  52.   for each node.  All of the files in the archive and the configurations
  53.   should be put into their own directory.
  54.  
  55.         Setting up the Viewer is fairly easy.  The first thing you need
  56.   to do is set up the config files.  They don't *have* to be called
  57.   VWANSI1.CFG, VWANSI2.CFG, etc... , but it maintains clarity and ease
  58.   of use if they are.  They take this form:
  59.  
  60.                 PCB                  {BBS Type}
  61.                 C:\BBS               {Dir of the node's door files}
  62.                 Works of Art BBS     {Name of BBS--registration name}
  63.                 Elm Morrow           {Sysop's full name}
  64.                 0                    {locked baud rate}
  65.                 NOT REGISTERED       {registration number}
  66.  
  67.         BBS Type can be of several types:
  68.  
  69.                 PCB             PCBoard
  70.                 GAP             GAP (DOOR.SYS)
  71.                 SF              Spitfire, 
  72.                 RBBS            RBBS  
  73.                 WC              WildCat!
  74.  
  75.   Wildcat 3.XX uses GAP (DOOR.SYS) the VWANSI.CFG would appear as
  76.   follows:
  77.                 GAP
  78.                 c:\WC30\DOORS\(subdir name)
  79.                 your BBS name
  80.                 sysop name
  81.                 0
  82.                 NOT REGISTERED
  83.  
  84.  
  85.         Location of definition files is the directory where your door
  86.   files are when the BBS shells out to the door.  In other words, if
  87.   you're running PCBoard, line 2 needs to point to the location of
  88.   PCBOARD.SYS, PCBOARD.DAT, and USERS for that node.
  89.  
  90.         BBS Name or registration name goes on line 3 of the config file.
  91.   I guess if you can't work that one out, I can't help you much! <grin>!
  92.  
  93.         SysOp Name should be the main SysOp's name as it appears in the
  94.   BBS configuration.  It's not really critical.
  95.  
  96.         Locked baud rate is for high speed modems.  If you lock your port
  97.   at 19200 or 38400, put it here in that form (i.e. 19200 or 38400).  This
  98.   door does not require a FOSSIL driver to run at high speeds.  If you 
  99.   have trouble, please contact me!  There have been some reports of
  100.   problems with CompuComs but the USR Dual Standards aren't having any
  101.   trouble.  I myself own a CompuCom Champ and the problem only seems
  102.   to occur with a Champ to Champ connection.  <sigh>....
  103.  
  104.         Registration number is the number you get from me that will replace
  105.   the word #UNREGISTERED# in the header of all the menus to whatever your
  106.   BBS name is (or whatever you register under---best to choose the BBS name).
  107.  
  108.         Okay!  Now for the stuff that isn't quite so easy....  In addition
  109.   to the configuration file, you need some definition files for the list
  110.   of categories and a list of files for each category.  I know, I know, who
  111.   needs manual setup?  Well, register the darn door and I'll put together
  112.   an automated/assisted setup program!
  113.  
  114.         Here are the files and their formats:
  115.  
  116.                                 CATEGORY.DAT
  117.                                 ------------
  118.         This file contains the list of categories to display on the initial
  119.   category menu.  It's very simple.  It's just a text file that contains
  120.   *SINGLE LINE ENTRIES* that define each element on the menu.  The format
  121.   goes a little something like this:
  122.  
  123.         <category file>,<category description>,<security level>
  124.  
  125.         The first part, <category file>, is the name (and path if it's in
  126.   a separate directory) of the file that contains the list of files in
  127.   this category.  See below.
  128.  
  129.         <category description> is what the user will see when they are
  130.   making their selections from the category menu.  It can be up to 50
  131.   characters in length.
  132.  
  133.         <security level> is the minimum security level the user must have
  134.   in order to be able to view this category.  Just set it to 0 if you don't
  135.   really care.  This is for those SysOps out there that like to segment
  136.   everything they do into different levels of access.
  137.  
  138.            *MAKE SURE YOU SEPARATE EACH FIELD WITH COMMAS!!!*
  139.  
  140.                                Category files
  141.                                --------------
  142.         Category files can have any name and/or extension that you want        
  143.   to give them.  I prefer to use the extension .CAT so I know what the
  144.   file is for.  It is also a normal text file that contains a list of
  145.   single line entries.  These entries will tell the computer what files
  146.   to display and where they are.  The form is similar to the CATEGORY.DAT
  147.   file:
  148.  
  149.            <d:\path\name.ext>,<file description>,<security level>
  150.  
  151.         The first element *must* be the full path and name of the file
  152.   that the user will view when they choose each selection.  If the file
  153.   resides in the same directory as VWANSI, then you only need to provide the
  154.   name and the extension.
  155.  
  156.         <file description> is what the user will see when they are making
  157.   their choices from the ANSI Files menu (or whatever the heck I called it).
  158.   It can be up to 50 characters in length.
  159.  
  160.         <security level> is the minimum security the user must have in 
  161.   order to view the individual file.  A little redundant, but it's very
  162.   easy to put a ,0 at the end of each line.  But, it's impossible to not
  163.   show the selection without this field if you want only some people to
  164.   be able to see it.  This will help avoid creating multiple categories
  165.   for different levels.
  166.  
  167.         That's it!  (as if that weren't enough! <grin>)  It may seem like
  168.   a lot to do, but if you don't have to put a bunch of categories and lists
  169.   together all at once, it's easy to maintain and all of this can be done
  170.   remotely by co-SysOps and other lesser BBS personalities <grin> (don't
  171.   get upset!  *I* used to be a co-SysOp that got to do the grunt work 
  172.   while *their* name went up in lights!)
  173.  
  174.  
  175.  
  176.   RUNNING THE DOOR:
  177.  
  178.         The batch file for this door is simple.  Do something like this:
  179.  
  180.                 cd c:\bbs\doors\vwansi
  181.                 vwansi vwansi1.cfg
  182.                 cd c:\bbs
  183.                 board
  184.  
  185.         There are many BBS schemes for setting up doors, so if this batch
  186.   file doesn't work for you, just read your doc's and find out how to run
  187.   doors.
  188.  
  189.   SPECIAL SYSOP KEYS:
  190.  
  191.      Key(s)              Function
  192.      ------              ---------
  193.      Scroll              If the Scroll Lock key is ON, you will here music
  194.       Lock               locally.  If it's off, you will not.
  195.  
  196.      HOME                Toggles between the user status  window and a
  197.                          help  display that  lists the  RMDoor special
  198.                          keys.
  199.  
  200.      F6                  Takes 5 minutes away from the caller.
  201.  
  202.      F7                  Gives 5 minutes to the caller.
  203.  
  204.      F9                  Quit the  door and  return the caller  to the
  205.                          BBS.
  206.  
  207.      F10                 Enter chat mode.   Pressing the ESC key exits
  208.                          the chat mode.
  209.  
  210.      Alt+D               Drop to DOS.
  211.  
  212.  
  213.  
  214.   USING THE DOOR:
  215.  
  216.         This is the easiest part.  All the user has to do is enter the
  217.   door and make menu selections!  *You've* done all the work!  Here are 
  218.   the few keys they need to know (they're informed while they're in the
  219.   door by a footer listing currently acceptable inputs.)
  220.  
  221.         <2>  -  Go down one selection
  222.         <8>  -  Go up one selection
  223.       <ENTER>-  Choose current selection
  224.        <ESC> -  Exit to last menu or the BBS
  225.  
  226.        That's it!
  227.  
  228.         It came to mind a little too late for this release, but the menus
  229.   support multiple pages.  If there are more selection beyond the end of
  230.   the ones currently viewed (11 at a time), pressing <2> one more time will
  231.   display the next set of selections.  Likewise, pressing <8> at the top of
  232.   the menu box will bring the previous page up.  I'll make a note of that
  233.   and put it on the display for the next upgrade  (definitely will be one).
  234.  
  235.  
  236.  
  237.   SUGGESTIONS, ETC...:
  238.  
  239.         I want to extend my gratitude to Randy Hunt for making this door
  240.   possible.  He gave me a lot of help getting it to work with file sharing
  241.   and he deserves a lot of credit. (Take a bow, Randy).
  242.  
  243.         Please leave your suggestions for improvements and any other 
  244.   comments on one or more of the following boards:
  245.  
  246.         The Works of Art BBS  (This is my board)
  247.         (707) 465-3193 (Node 1) or 
  248.         (707) 465-6765 (Node 2) from 9:00pm to
  249.                                      9:00am.
  250.  
  251.         Conference:  Mail Room
  252.  
  253.         
  254.         The WheelChair Express
  255.         (707) 464-3705  Node 1
  256.         (707) 465-1272  Node 2
  257.  
  258.         Conference:  Message Center
  259.  
  260.         
  261.  
  262.         Of course, there's always snail mail.  As a general rule, I don't
  263.   like answering letters, but if you send a check or m.o. for $15 with a
  264.   letter, I'll more than likely get in touch with you one way or the other.
  265.  
  266.         If I've missed something or you can't make sense out of all or part
  267.   of this .DOC file, get in touch and let me know.  It's really not that
  268.   hard to get it set up, but I don't always feel like writing and so the
  269.   descriptions of how to do things get erratic and confusing.  <Sigh>
  270.  
  271.  
  272.  
  273.   KNOWN BUGS:
  274.  
  275.         For some reason when one of my ßeta tester who uses a CompuCom
  276.   Champ hooks up with another CompuCom, it blows the display.  It doesn't
  277.   lock up the board or anything, but it just won't show the displays
  278.   correctly.  We're currently trying to get that worked out.
  279.  
  280.   HISTORY:
  281.         Version 1.1 
  282.                 was released simply to remove the ShareWare notice that
  283.   my door unit was putting just before entry to the door.  I'm registered
  284.   now, so it's gone.
  285.  
  286.  
  287.         Version 2.0
  288.                 This new multinode version now supports ANSI music!
  289.  
  290.                 Added a local music on/off toggle (scroll lock) and
  291.         cleaned up the music routines a little.
  292.  
  293.